home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / UTIL / DESKTOP / ICONTHANG / !IconThang / !Help next >
Text File  |  1997-10-10  |  10KB  |  252 lines
  1. > <iconthang$dir>.!Help
  2.  
  3. When the sirens wail and the lights flash blue ...
  4.  
  5.  
  6. (sorry about the state of this helptext... it's grown rather organically
  7. over the years :-)
  8.  
  9. Sections that are new since version 3.31 are marked **NEW**
  10.  
  11.  
  12. Right, this is !IconThang V3.49b © Musus Umbra 1995-7, Zzzzz....
  13. Permission is granted for unrestricted use/abuse. Permission is granted
  14. for re-distribution by whatever means, so long as no charge is made for
  15. the software (a reasonable charge may be made for handling/media/etc) and
  16. the whole application is supplied unaltered.
  17. No warranty of any kind, either express or implied, applies to this
  18. software. Use at your own risk, indeed with your own RISC.
  19.  
  20. **NEW**
  21. IconThang is now FULLY compatable with RISC OS 2 as well as later versions!
  22. Somebody requested a RO2 version, and look what happens: A brand new
  23. version with loadsa new features, many problems fixed, AND it works
  24. with RISC OS 2... 3d borders and all.
  25.  
  26.  
  27. All known/reported bugs/mis-features have been fixed in this version :-)
  28.  
  29.  
  30.  
  31. What is !IconThang?
  32. ~~~~~~~~~~~~~~~~~~~
  33. Main features:
  34.     * Automatic changeover of hi/low res. desktop sprites, IF NECESARRY, on
  35.       mode change. Some nice sprites are supplied. No more 'Ugh!
  36.       What's that ugly blue blotch with a few white dots on it?!'
  37.       from now on you'll be able to tell it's a BASIC file...
  38.       (you can turn this off).
  39.     * (RiscPC) automatic swap over between Outline & System fonts on
  40.       changing between Hi & Low res. screen modes.  (you can turn this
  41.       off too :-)
  42.     * Easy access to your most used apps/commands
  43.     * Easy to configure
  44.     * Displays current memory available
  45.     * and the time
  46.     * and how long the computer's been running
  47.  
  48. Basically it's a small window that sits at the top-right hand corner of the
  49. desktop and tries its best not to be noticed...
  50.  
  51. But, should you click on one of the icons in the window you'll be presented
  52. with a menu of files/applications/directories/... pertinent to whatever the
  53. icon represents. (Try it, you'll see)
  54.  
  55. As supplied, the app. doesn't do much. This is where you set it up for your system...
  56. The window has 14 icons (numbered from left to right). The first of which is
  57. immediately to the right of the !iconthang icon. Each of these icons is
  58. defined in the Config file in the !iconthang directory. Each icon has a
  59. description, sprite and menu associated with it. The format of the file !Config
  60. is:
  61.     Enable automatic iconspriting (either 'Yes' or 'No')
  62. ...and then...
  63.     Menutitle
  64.     spritename
  65.     Description
  66.     ---menu entries---
  67.     **
  68. for 14 menus.
  69.  
  70.  
  71. The Menutitle is the title to give that menu.  Keep it short and piffy.
  72. *NEW*
  73. You can have menu titles longer than 12 characters if you want.
  74.  
  75. The spritename line tells IconThang what sprite to use for that menu. There
  76. should be a hi & low res. version of this sprite in the Sprites22 & Sprites24
  77. files (respectively) within the !Iconthang directory. The sprites don't have
  78. to be in these files, if they aren't, but exist in the Wimp sprite pool, the
  79. wimp sprite will be used, otherwise the icon will be blank. The Sprites22
  80. & Sprites24 files supplied in the examples directory contain the icons I use,
  81. feel free to copy any of them...
  82.  
  83. The Description line is used to remind you what the menu is for.  When the
  84. pointer is over the relevant icon in the window, this description will be
  85. displayed in the title bar.
  86.  
  87.  
  88. The format of a menu entry is:
  89.     Filename
  90. or
  91.     *.command
  92. or
  93.     *command .parameters
  94.  
  95. This may seem a little complex, but the way it works is this:
  96.  
  97. When building the menus, the program looks at each menu entry. If its first
  98. character is an asterisk it is deemed to be a command, otherwise it is treated
  99. as a filename (filename includes directories/applications/images/...).
  100.  
  101. Filenames have their paths stored, and only the leafname put into the menu.
  102. When you select the leafname from a menu, the app. rebuilds the complete name
  103. and Runs it. (**NEW** See below for modifier keys you can use!)
  104.  
  105. Commands are treated specially. The 'leaf' of the command, ie. the text after
  106. the '.' character is put in the menu, and the text of the command to the left
  107. of the '.' is stored (inc. any spaces). When you select the 'leaf' of the
  108. command, the complete command text is rebuilt by catenating the stored text
  109. with the 'leaf' text.
  110.  
  111. So,
  112.     *.fred
  113. would appear in the menu as 'fred' and the command executed would be *fred
  114.     *backdrop -t .fred
  115. would also appear as fred, but be executed as *backdrop -t fred
  116.  
  117. Simple, when you get the hang of it, really.
  118.  
  119. *NEW*
  120. Additionally, you may preceed any of the above Filename/Command formats with a
  121. label in \s.  This label will be used as the entry for that command/file/etc.
  122. in the menu.  For example:
  123.     \Turn the speaker on\*Speaker on
  124. would appear in the menu as 'Turn the speaker on' but issue the command
  125. '*Speaker on' when selected.  See the example config file for some, um,
  126. examples.
  127.  
  128.  
  129.  
  130. There is no provision for any automatic creation/editting of the Config file,
  131. I'm afraid you have to do it be hand. The only 'sweetners' provided are that
  132. should you be holding Control down of the keyboard when you quit iconthang,
  133. or click on the 'Quit' menu entry with adjust, its directory will be opened,
  134. allowing *very* easy access to the Config file / Sprite files, etc.
  135.  
  136. Also, selecting 'Edit Config' from the menu will filer_run the congfig file
  137. (which should load it into your favourite text editor) without quitting the
  138. application. When you're happy, use 'Reload Cfg' from the menu to reload
  139. the configuration into iconthang.
  140.  
  141. Included in the directory 'examples' is an example config file (actually, it's
  142. my config file) so you can have a look at the sort of thing possible.
  143.  
  144. Handy hint: if you drag a file/application into any decent text editor's
  145. window whilst holding <shift> down, the full path/leaf name will be inserted
  146. at the cursor/caret position.
  147. This makes adding new entries to iconthang so easy that I didn't even
  148. consider a configuration program... Anyways, config files are unlikely to
  149. change often or dramatically)
  150.  
  151.  
  152. Okay so far?
  153.  
  154. (Due to size, the !Sprites/!Sprites22 files referred to below are drastically
  155. cut down versions of the ones I used to supply.  The intention is that you
  156. will add to them as the fancy takes you.  Alternatively, if you simply *must*
  157. have my sprites, drop me an e-mail and I'll see what I can do.  If there's
  158. enough demand I'll make my sprites available for all... I'm rather proud
  159. of them and they've attracted more (nice) comments than Iconthang itself :-)
  160.  
  161. The Iconsprite directory inside !IconThang contains two sprite files,
  162. '!Sprites' and '!Sprites22'. When a mode change within the desktop occurs, the
  163. screen resolution is tested and compared with the resolution of the previous
  164. mode. If they differ (eg. changing from mode 12 to mode 20, or 27->39, etc)
  165. then the appropriate file is *iconsprites'd (you'll see the pointer turn into a
  166. spritefile-esque icon to let you know what the delay is).
  167.  
  168. Only mode *changes* *within* the desktop will cause the iconsprites to change.
  169. This is where iconthang scores over other icon switching solutions, in that
  170. they tend to swap the icons *whenever* a mode change occurs. Frequently,
  171. you'll be in a hi-res. mode, run a game which changes to a low res. mode
  172. (basically, most of them) and then quit back to the desktop. Iconthang won't
  173. do any thing, the other iconswitchers would have swapped the icons *twice*
  174. (sometimes causing unpleasantness because the iconsprites command has altered
  175. the memory allocation and confused the game).
  176. Note, the *wimpmode command will still swap the icons *when* control returns
  177. to the desktop.
  178.  
  179. Note that you can edit the !Run file to look for these files elsewhere.  I,
  180. for example, keep my alternate sprite sets in a completely different place.
  181.  
  182.  
  183. Useful, no?
  184.  
  185. The 'Force 22' and 'Force 24' menu entries can be used to iconsprites the
  186. relevant hi or low res sprites, irrespective of the current screen mode.
  187.  
  188.  
  189. *NEW*
  190. On RiscPC machines the desktop is usually displayed using an outline font
  191. rather than the system font.  Whilst this is all well and good in high
  192. resolution screen modes, should you change into a low resolution mode
  193. (perhaps to get more screen area), it can be fuzzy to the point of
  194. annoyance (even with sub-pixel antialiasing :-).  Iconthang can automagically
  195. swap between your desktop font and the system font when the screen resolution
  196. changes.  Indeed, Iconthang will allow you to swap between them with a simple
  197. menu selection - this is useful for using apps. whose windows are a mess
  198. when using a proportionaly-spaced font.  Also, some apps are much more
  199. responsive when using the system font (Personal Accounts 3 springs to mind :-)
  200.  
  201.  
  202. *NEW*
  203. Some people like to have natty little clocks / logos in the same place that
  204. !Iconthang sticks its window!  Horror!  Thankfully, you can tell Iconthang to
  205. swap over to being on the left-hand side of the desktop.  Heck, some people
  206. would prefer it to be there anyway.
  207.  
  208. *NEW*
  209. Iconthang now colours its menus to show whether an entry is a directory/app,
  210. a command or a file.  To do this, Iconthang 'looks for' all the items in your
  211. config file whenever started or the configuration is reloaded.
  212. The colour scheme is:
  213.     Blue    An application or directory
  214.     Green    A command
  215.     Grey    A file/directory/app that wasn't found
  216.     Red    A file/directory/app that caused an error when looked for
  217.         (usually due to a typo in the Config file)
  218.  
  219.  
  220. **NEW**
  221. You can now use the following keys to modify the action that Iconthang
  222. takes when a file/dir/app entry is selected:
  223.     Shift    Open the directory/app, just like shift-double clicking
  224.         in the filer.
  225.         For files, shift-selecting will attempt to load them
  226.         as textfiles into an apropriate editor (as is usual under
  227.         RISC OS 3).
  228.     Alt    Opens the directory containing the selected file/dir/app.
  229.  
  230.  
  231. **NEW**
  232. Iconthang doesn't use a 'real' titlebar.  This, of course, means no 'back' icon.  So, the area at the top of the window acts as a back/front icon.
  233. Sorted.
  234.  
  235.  
  236.  
  237. That only leaves the useful info in the title bar. Explanation thereof is
  238. beyond the scope of this document :-)
  239.  
  240. Oh yes, the app. uses different windows in different modes. This is so that
  241. in hi-res. modes the 'title bar' can be half-height, saving several valuable
  242. pixels desktop space!
  243.  
  244.  
  245.  
  246. TTFN, Musus Umbra
  247.  
  248. contact:
  249.     musus@argonet.co.uk
  250.     http://www.argonet.co.uk/users/musus/
  251.     c/o 23 Baronsway, Whitkirk, Leeds, LS15 7AW, England
  252.